Pocketbase Kotlin/io.github.agrevster.pocketbaseKotlin.models

Package-level declarations

Types

@Serializable

open class AuthCollection(val authRule: String? = null, val manageRule: String? = null, val authAlert: AuthCollection.AuthAlertOptions? = null, val oauth2: AuthCollection.OAuth2Options? = null, val passwordAuth: AuthCollection.PasswordAuthOptions? = null, val mfa: AuthCollection.MFAOptions? = null, val otp: AuthCollection.OTPOptions? = null, val authToken: <Error class: unknown class>? = null, val passwordResetToken: <Error class: unknown class>? = null, val emailChangeToken: <Error class: unknown class>? = null, val verificationToken: <Error class: unknown class>? = null, val fileToken: <Error class: unknown class>? = null, val verificationTemplate: AuthCollection.EmailTemplate? = null, val resetPasswordTemplate: AuthCollection.EmailTemplate? = null, val confirmEmailChangeTemplate: AuthCollection.EmailTemplate? = null) : Collection

This class contains the fields found in auth collections, extend it if you want to view these fields.

AuthRecord

@Serializable

open class AuthRecord(val email: String, val emailVisibility: Boolean, val verified: Boolean, authRecordId: String? = null) : Record

An easy wrapper for the Pocketbase auth collection record. If you want to work with custom fields use your own object which extends this one.

Collection

@Serializable

open class Collection(val name: String? = null, val type: Collection.CollectionType? = null, val system: Boolean? = null, val fields: List<SchemaField>? = null, val listRule: String? = null, val viewRule: String? = null, val createRule: String? = null, val updateRule: String? = null, val deleteRule: String? = null, val indexes: List<String>? = null, collectionId: String? = null) : TimestampedModel

The object returned from the Pocketbase Collections API. Depending on the collection type, if you would like access to addition methods see CollectionType's comments.

CronJob

@Serializable

data class CronJob(val expression: String) : BaseModel

A Pocketbase app cron job used by the CronService.

ExternalAuth

@Serializable

open class ExternalAuth : TimestampedModel

A Pocketbase external authentication provider

GeoPoint

@Serializable

data class GeoPoint(val lon: Float? = null, val lat: Float? = null)

Used to represent a Pocketbase geo point record field.

Log

@Serializable

data class Log(val message: String? = null, val level: Int? = null, val data: Map<String, JsonElement>? = null) : BaseModel

The object returned from the Pocketbase Log API.

Record

@Serializable

open class Record(recordId: String? = null) : BaseModel

A Pocketbase record retried from an API call.

ViewCollection

@Serializable

open class ViewCollection(val viewQuery: String? = null, _name: String? = null, _system: Boolean? = null, _fields: List<SchemaField>? = null, _listRule: String? = null, _viewRule: String? = null, _createRule: String? = null, _updateRule: String? = null, _deleteRule: String? = null, _indexes: List<String>? = null, collectionId: String? = null) : Collection

Used to represent a Collection with the type of view. If you would like access to view collection fields extend this class.